PortOne Server SDK for JVM/io.portone.sdk.server.payment.cashreceipt

Package-level declarations

Types

@Serializable

data class CancelCashReceiptResponse(val cancelledAmount: Long, val cancelledAt: @Serializable(with = InstantSerializer::class) Instant)

현금 영수증 취소 성공 응답

CancelledCashReceipt

@Serializable

@SerialName(value = "CANCELLED")

data class CancelledCashReceipt(val merchantId: String, val storeId: String, val paymentId: String, val channel: SelectedChannel, val amount: Long, val taxFreeAmount: Long? = null, val vatAmount: Long? = null, val currency: Currency, val orderName: String, val isManual: Boolean, val type: CashReceiptType? = null, val pgReceiptId: String? = null, val issueNumber: String, val url: String? = null, val issuedAt: @Serializable(with = InstantSerializer::class) Instant, val cancelledAt: @Serializable(with = InstantSerializer::class) Instant, val statusUpdatedAt: @Serializable(with = InstantSerializer::class) Instant? = null) : CashReceipt.Recognized

발급 취소

CashReceipt

@Serializable(with = CashReceiptSerializer::class)

sealed interface CashReceipt

현금영수증 내역

CashReceiptClient

class CashReceiptClient(apiSecret: String, apiBase: String = "https://api.portone.io", storeId: String? = null) : Closeable

API Secret을 사용해 포트원 API 클라이언트를 생성합니다.

CashReceiptFilterInput

@Serializable

data class CashReceiptFilterInput(val storeId: String? = null, val timeRangeField: CashReceiptTimeRangeField? = null, val from: @Serializable(with = InstantSerializer::class) Instant? = null, val until: @Serializable(with = InstantSerializer::class) Instant? = null, val paymentId: String? = null, val isTest: Boolean? = null, val orderName: String? = null, val statuses: List<CashReceiptStatus>? = null, val isManual: Boolean? = null, val pgReceiptId: String? = null, val pgMerchantId: String? = null, val pgProviders: List<PgProvider>? = null, val pgCompanies: List<PgCompany>? = null, val version: PortOneVersion? = null, val types: List<CashReceiptType>? = null)

현금영수증 다건 조회를 위한 입력 정보

CashReceiptSerializer

object CashReceiptSerializer : JsonContentPolymorphicSerializer<CashReceipt>

CashReceiptSortBy

@Serializable(with = CashReceiptSortBySerializer::class)

sealed interface CashReceiptSortBy

현금영수증 정렬 기준

CashReceiptSortBySerializer

object CashReceiptSortBySerializer : KSerializer<CashReceiptSortBy>

CashReceiptSortInput

@Serializable

data class CashReceiptSortInput(val by: CashReceiptSortBy? = null, val order: SortOrder? = null)

현금영수증 다건 조회 시 정렬 조건

CashReceiptStatus

@Serializable(with = CashReceiptStatusSerializer::class)

sealed interface CashReceiptStatus

현금영수증 발급 건 상태

CashReceiptStatusSerializer

object CashReceiptStatusSerializer : KSerializer<CashReceiptStatus>

CashReceiptSummary

@Serializable

data class CashReceiptSummary(val issueNumber: String, val url: String, val pgReceiptId: String)

현금영수증 내역

CashReceiptTimeRangeField

@Serializable(with = CashReceiptTimeRangeFieldSerializer::class)

sealed interface CashReceiptTimeRangeField

현금영수증 다건 조회 시, 시각 범위를 적용할 필드

CashReceiptTimeRangeFieldSerializer

object CashReceiptTimeRangeFieldSerializer : KSerializer<CashReceiptTimeRangeField>

GetCashReceiptsResponse

@Serializable

data class GetCashReceiptsResponse(val items: List<CashReceipt>, val page: PageInfo)

현금영수증 다건 조회 성공 응답 정보

IssueCashReceiptCustomerInput

@Serializable

data class IssueCashReceiptCustomerInput(val identityNumber: String, val identityNumberType: IssueCashReceiptCustomerInputIdentityNumberType? = null, val name: String? = null, val email: String? = null, val phoneNumber: String? = null)

현금영수증 발급 시 고객 관련 입력 정보

IssueCashReceiptCustomerInputIdentityNumberType

@Serializable(with = IssueCashReceiptCustomerInputIdentityNumberTypeSerializer::class)

sealed interface IssueCashReceiptCustomerInputIdentityNumberType

현금영수증 발급 시 고객 식별 정보 유형

IssueCashReceiptCustomerInputIdentityNumberTypeSerializer

object IssueCashReceiptCustomerInputIdentityNumberTypeSerializer : KSerializer<IssueCashReceiptCustomerInputIdentityNumberType>

IssueCashReceiptPaymentMethodType

@Serializable(with = IssueCashReceiptPaymentMethodTypeSerializer::class)

sealed interface IssueCashReceiptPaymentMethodType

현금영수증 발급 가능 결제 수단

IssueCashReceiptPaymentMethodTypeSerializer

object IssueCashReceiptPaymentMethodTypeSerializer : KSerializer<IssueCashReceiptPaymentMethodType>

IssueCashReceiptResponse

@Serializable

data class IssueCashReceiptResponse(val cashReceipt: CashReceiptSummary)

현금 영수증 발급 성공 응답

IssuedCashReceipt

@Serializable

@SerialName(value = "ISSUED")

data class IssuedCashReceipt(val merchantId: String, val storeId: String, val paymentId: String, val channel: SelectedChannel, val amount: Long, val taxFreeAmount: Long? = null, val vatAmount: Long? = null, val currency: Currency, val orderName: String, val isManual: Boolean, val type: CashReceiptType? = null, val pgReceiptId: String? = null, val issueNumber: String, val url: String? = null, val issuedAt: @Serializable(with = InstantSerializer::class) Instant, val statusUpdatedAt: @Serializable(with = InstantSerializer::class) Instant? = null) : CashReceipt.Recognized

발급 완료

IssueFailedCashReceipt

@Serializable

@SerialName(value = "ISSUE_FAILED")

data class IssueFailedCashReceipt(val merchantId: String, val storeId: String, val paymentId: String, val channel: SelectedChannel? = null, val orderName: String, val isManual: Boolean, val statusUpdatedAt: @Serializable(with = InstantSerializer::class) Instant? = null) : CashReceipt.Recognized

발급 실패